/* Copyright (C) 2008  Romolo Camplani, Marco Fortunato, Marco Marelli, Guido Rota, Fabio A. Schreiber et al.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.dei.perla.parser.datastructures;

import org.dei.perla.parser.expressions.Constant;
import org.dei.perla.parser.util.FieldType;

/**
 * La definizione del campo di uno Stream o di uno Snapshot, composto da un nome, da un tipo di dato e da un valore di default
 */
public class Field {
	
	/**
	 * Il nome del campo
	 */
	private String name;
	
	/**
	 * Il tipo di dato del campo
	 */
	private FieldType type;
	
	/**
	 * Il valore di default dei dati contenuti nel campo
	 */
	private Constant defaultValue;	
	
	
	/**
	 * Restituisce il nome del campo
	 */
	public String getName() {
		return this.name;
	}
	
	/**
	 * Imposta il nome del campo
	 */
	public void setName(String name) {
		this.name = name;
	}
	
	/**
	 * Restituisce il tipo di dato contenuto nel campo
	 */
	public FieldType getType() {
		return this.type;
	}
	
	/**
	 * Imposta il tipo di dato contenuto nel campo
	 */
	public void setType(FieldType type) {
		this.type = type;
	}
	
	/**
	 * Restituisce il valore di default del campo
	 */
	public Constant getDefaultValue() {
		return this.defaultValue;
	}
	
	/**
	 * Imposta il valore di default dei dati contenuti nel campo
	 */
	public void setDefaultValue(Constant defaultValue) {
		this.defaultValue = defaultValue;
	}
		
	/**
	 * Restituisce lo spezzone di codice "perla" corrispondente
	 */
	public String toString() {
		String stringToReturn = "";
		
		// Aggiunge il nome del campo
		if(this.name == null)
			stringToReturn += "<field_name>";
		else
			stringToReturn += this.name;
		
		// Aggiunge uno spazio
		stringToReturn += " ";
		
		// Aggiunge il tipo del campo
		if(this.type == null)
			stringToReturn += "<field_type>";
		else
			stringToReturn += this.type.toString();
		
		// Aggiunge il valore di defautl del campo (se specificato)
		if(this.defaultValue != null)
			stringToReturn += " DEFAULT " + this.defaultValue;		
		
		
		// Ritorna la stringa costruita
		return stringToReturn;
	}
}
